home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 6: Level 6 / 17 Bit - Level 6 (1998)(Epic Marketing)[!].iso / !applications! / ppmini / ppminicrunch.doc < prev    next >
Text File  |  1992-09-02  |  10KB  |  240 lines
  1.  
  2.  
  3.   PPMiniCrunch v1.2
  4.   ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  5.  
  6. Documentation
  7. =============
  8.  
  9. oO°System Requirements°Oo
  10. -------------------------
  11.  
  12. PPMiniCrunch requires KickStart 2.04 (v37) or above and powerpacker.library
  13. v35 or above. Otherwise should work on any memory/hardware configuration.
  14.  
  15. oO°Installation°Oo
  16. ------------------
  17.  
  18. To run this program the files,
  19.  
  20.     powerpacker.library
  21.     asl.library
  22.  
  23. must be in the LIBS directory on your boot disk or in any directory included
  24. in the LIBS: assign.
  25.  
  26. oO°What it is°Oo
  27. ----------------
  28.  
  29. PPMiniCrunch is a data file cruncher/decruncher that uses powerpacker
  30. library and provides a small low memory gadtools front-end. It was written
  31. as a substitute for powerpacker for when powerpacker's more obscure
  32. functions aren't required, mainly for people using a floppy based
  33. system as powerpacker is too large (around 70k) to have on workbench
  34. disks etc. PPMiniCrunch is designed to be user friendly with gadgets for
  35. all functions, and keyboard shortcuts for all gadgets.
  36.  
  37. oO°How to use it°Oo
  38. -------------------
  39.  
  40. -= Running PPMiniCrunch from the Shell =-
  41.  
  42. To run PPMiniCrunch activate a shell/CLI window and type PPMiniCrunch
  43. preceded by a path if PPMiniCrunch is not in the current directory or
  44. a directory specified in the path list.
  45.  
  46. The PPMiniCrunch requester will then appear on the Workbench screen. All
  47. functions (listed below) are controlled from this requester. Current program
  48. status/information is displayed in the text gadget at the top of the window.
  49.  
  50. PPMiniCrunch also has several command line options. The format of these is
  51. as follows:
  52.  
  53.     PPMiniCrunch FILE|DIR C=CUSTOMSCREEN/S
  54.  
  55. and can be displayed by typing:
  56.  
  57.     PPMiniCrunch ?
  58.  
  59. Specifying the CUSTOMSCREEN option (i.e. "PPMiniCrunch c" or "PPMiniCrunch
  60. customscreen"), will make PPMiniCrunch open on it's own screen rather than
  61. the default workbench screen. This uses about 45K of extra memory on my
  62. machine. PPMiniCrunch uses a 4 colour hires non-interlaced display for its
  63. custom screen.
  64.  
  65. Specifying the FILE|DIR option will set the file requester default directory
  66. to the path specified or to the path of the specified file. If a filename
  67. is included in the path then PPMiniCrunch will attempt to load it as if it
  68. was selected using the 'Source' gadget (see below). If the file specified is
  69. already crunched it will be loaded and decrunched, otherwise it will be
  70. selected ready for crunching using the 'Crunch' gadget (see below).
  71.  
  72. e.g.
  73.     PPMiniCrunch df1:Modules/mod.Voodoo_Chile_(Slight_Return).pp C
  74.  
  75. will set the current directory for disk operations (loading and saving) to
  76. 'df1:Modules', and will attempt to load and decrunch the powerpacked file,
  77. 'mod.Voodoo_Chile_(Slight_Return).pp'. Oh, and all this will happen on a
  78. custom screen.
  79.  
  80. -= Running PPMiniCrunch from Workbench =-
  81.  
  82. To run PPMiniCrunch from the Workbench use one of the following three
  83. methods:
  84.  
  85.   o    Double-click on the PPMiniCrunch icon and the window will open
  86.        allowing you to operate the program as described below.
  87.  
  88.   o    To load a file for crunching/decrunching as PPMiniCrunch loads, click once on
  89.        the PPMiniCrunch icon and then, while holding down the shift key
  90.        double-click on the icon of the file you wish to crunch/decrunch.
  91.        PPMiniCrunch will be loaded and if the file you selected was already
  92.        crunched it will be decrunched ready for saving, otherwise it will be
  93.        selected ready for crunching using the 'Crunch' gadget (see below).
  94.  
  95.   o    Alternatively you can click once on the PPMiniCrunch icon and then,
  96.        while holding down the shift key, double click on a drawer icon. This
  97.        will load PPMiniCrunch as normal, but when you press the 'Source' or
  98.        'Save' gadgets (see below), the default directory for the file
  99.        requester will be the one you double-clicked on.
  100.  
  101. To tell PPMiniCrunch to open on a custom screen you must use the Information
  102. option in the Tools menu of the Workbench screen. Set one of the ToolTypes
  103. to the following string if it does not already exist:
  104.  
  105.     CUSTOMSCREEN=ON
  106.  
  107. This will tell PPMiniCrunch to open on a custom screen rather than the
  108. workbench screen. The ON keyword in the above string can be changed to
  109. YES yielding the same result as ON, or it can be replaced with anything
  110. else, e.g. NO, OFF etc. to disable the option and make PPMiniCrunch open
  111. on the workbench screen.
  112.  
  113. -= Controlling PPMiniCrunch =-
  114.  
  115. The following options are available using the gadgets in the PPMiniCrunch
  116. window:
  117.  
  118. -Selecting a source file for crunching/decrunching
  119.  
  120. Click on the 'Source' gadget or press the keyboard shortcut - "O". This
  121. will select a file for crunching unless the file is already crunched in
  122. which case it is loaded and decrunched ready for saving as an uncrunched
  123. file. The size of the uncrunched file will be displayed in the 'Original
  124. Length' number gadget, and if a crunched file was loaded (and decrunched)
  125. the 'Crunched Length' number gadget will display the original length of the
  126. file (before it was decrunched).
  127.  
  128. -Choosing the crunch efficiency
  129.  
  130. The quality of the crunching can be controlled by the mutually exclusive
  131. 'Crunch Efficiency' gadget. 'Best' is slower than the other options but
  132. provides the greatest crunch factor. 'Fast' is the fastest but provides the
  133. least saving in file size. These settings are used when the Crunch gadget
  134. is activated. The list can be cycled through using the keyboard shortcut -
  135. "E", either forwards by pressing E unshifted or backwards by pressing
  136. E with the shift key.
  137.  
  138. -Choosing the speedup buffer size
  139.  
  140. If you have enough memory the buffer used for crunching can be increased
  141. by selecting 'Large' in the mutually exclusive 'Speedup Buffer' gadget.
  142. This gives a large increase in crunch speed whereas selecting 'Small'
  143. decreases the speed slightly but uses less memory than the default, 'Medium'.
  144. The list can be cycled through using the keyboard shortcut - "B", either
  145. forwards by pressing B unshifted or backwards by pressing B with the shift
  146. key.
  147.  
  148. -Crunching the current file
  149.  
  150. If a valid uncrunched file was selected (using the 'Source' gadget), then
  151. the 'Crunch' gadget will be enabled. Selecting this gadget will then
  152. decrunch the current data file and the percentage gain will be displayed
  153. in the info gadget, along with the crunched data length in the 'Crunched
  154. Length' number gadget. The data can then be saved by clicking on the 'Save'
  155. gadget if no errors ocurred during crunching. While the file is crunching,
  156. the text info box (at the top of the window) will become highlighted from
  157. left to right in proportion to the percentage of crunching done. This should
  158. give you a fair idea of how long a file will take to crunch once started.
  159. If this seems like too long or for any other reason, crunching can be
  160. aborted by pressing the right mouse button.
  161.  
  162. -Saving the current file
  163.  
  164. If the original file (selected with the 'Source' gadget) was already
  165. crunched then it will have been loaded and decrunched. It can then be
  166. saved as an uncrunched file by selecting the 'Save' gadget. If the original
  167. file was uncrunched then the 'Save' gadget will only be enabled after the
  168. file has been crunched (see above), in which case selecting 'Save' allows
  169. you to save the crunched data to a file. Save can be selected either by
  170. clicking on the 'Save' gadget or by pressing the keyboard shortcut - "S".
  171.  
  172. -Quitting from PPMiniCrunch
  173.  
  174. You can quit PPMiniCrunch at any time by clicking on the 'Quit' gadget or
  175. by pressing the keyboard shortcut - "Q"
  176.  
  177.  
  178. PPMiniCrunch displays error messages and verification messages when any
  179. operation is performed. When PPMiniCrunch is currently saving data, loading
  180. data, crunching/decrunching data, or displaying a file requester the mouse
  181. pointer will change to a busy mouse pointer when the PPMiniCrunch requester
  182. window is activated.
  183.  
  184.  
  185. Have fun with PPMiniCrunch ;-]
  186.  
  187.  
  188. oO°Other bits°Oo
  189. ----------------
  190.  
  191. PPMiniCrunch is Copyright 1993 Sam Baker.
  192.  
  193. PPMiniCrunch is Public Domain and must not be sold for any amount of money
  194. without my permission. The program file, 'PPMiniCrunch' should only be
  195. distributed with the following files -
  196.  
  197.         PPMiniCrunch.doc     (this file)
  198.         PPMiniCrunch.history
  199.  
  200. PPMiniCrunch was written in assembler/E using Amiga E, the excellent public
  201. domain E compiler/68000 assembler by someone whose name I have forgotten.
  202. It was written on a standard A1200 using Amiga E, the Devpac v3.02 editor
  203. and a few blank disks. Oh and the powerpacker.library documentation and the
  204. v37 Amiga ROM Kernel manuals.
  205.  
  206. -Obtaining the source
  207.  
  208. For the PPMiniCrunch source code (the latest version) and the latest version
  209. in executable form please send £2.50(inc.P&P) to:
  210.  
  211. Sam Baker
  212.  
  213. 100 Beauley Road
  214. Southville
  215. Bristol
  216. BS3 1QG
  217.  
  218. England
  219.  
  220. I would also appreciate any suggested improvements or bug reports at the
  221. same address.....Cheers :-)
  222.  
  223. oO°Advert°Oo
  224. ------------
  225.  
  226.  COMING SOON:
  227.  
  228.    Defektris (the name may change before release)
  229.  
  230.    The new falling blocks game enhanced with new and exciting originality
  231.    by Sam Baker. A free preview version can be obtained direct from me (the
  232.    author) by sending a disk and a stamped self-addressed envelope/jiffy bag
  233.    to the address above. This preview should work on all Amigas and will
  234.    include details of how to register and obtain the full version. (But only
  235.    if you like it :-]). Defektris is written in 100% assembly language and
  236.    the source will also be available - details with the preview version.
  237.    * Most definitely AGA compatible 'cause it was written on an A1200.
  238.    * OS 3.0 and 1.3 and 68000 and 68020 processor compatible.
  239.    * Works with 0.5 Mb of RAM.
  240.    * Hard disk installable.